-
Notifications
You must be signed in to change notification settings - Fork 31
feat: [sc-108273] GTM Enablement: Improve the docs to make it easier to discover/understand how to get your cluster usage history via API & UI #3007
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Kyle Squizzato <[email protected]>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Kyle Squizzato <[email protected]>
Signed-off-by: Kyle Squizzato <[email protected]>
Signed-off-by: Kyle Squizzato <[email protected]>
|
I put the article under https://deploy-preview-3007--replicated-docs-upgrade.netlify.app/vendor/compatibility-matrix-usage |
| --header 'accept: application/json' | ||
| ``` | ||
|
|
||
| You can specify `total-only=true` to get a quick total count of terminated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I should probably move this total-only section under the Unique to this endpoint text/bullets.
tiny copy edit
| The column will display an up or down arrow to denote that the column is being | ||
| sorted and the direction of the sort: | ||
|
|
||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this section of screenshots take up too much page real estate now. @paigecalvert may have a better idea of how to optimize them, but I currently lean to removing them given that they don't provide a ton of value as the filtering is fairly easy to understand conceptually and in the product.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know @paigecalvert stated using callouts to images, but I wasn't sure what the syntax was on that, that's a potential other way we could do this, or we can remove them, whatever works...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left in the one showing the result of filtering and removed the others
| ## Currently Active Clusters and Virtual Machines | ||
| You can find current active clusters and virtual machines (VMs) on the Compatibility | ||
| Matrix overview page which is accessible by clicking the **Compatibility Matrix** | ||
| tab and then selecting **Overview** from the sidebar. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only currently true for someone that has the VM feature flag turned on right now. For everyone else, this doesn't say "Overview" it says "Clusters". However, I'm not opposed to this remaining as-is. It will become correct soon, and it's not that hard to figure out the mapping if someone is looking for the overview page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That works for me--we don't mention VMs anywhere currently in the cmx docs but I'm not worried about it if we're going to start documenting that feature soon
That doesn't feel like the right section because all of that telemetry is currently exclusively about end customer data visibility and insights, and not about team actions taken within VP. I think the best section is within the CMX section. We know these docs are a bit rough, and we already need to touch them again to add support for VMs, so for now it probably makes sense to go with a sub-section like "Viewing Compatibility Matrix Usage" under CMX docs, unless @paigecalvert has a better wording suggestion than me :) |
|  | ||
| [View a larger version of this image](/images/compatibility-matrix-column-filter-input.png) | ||
|
|
||
| ## Get Usage History with the Vendor API v3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I usually don't document API stuff in the Replicated docs site, as it typically ends up becoming another place to remember to update outside of the API docs themselves (as in, another place that is bound to get out of date 😅 ). Ideally any gaps in information/docs for the API would be edited in the API docs rather than patched in the docs site
My pattern in other topics is to say something like "this topic shows you how to do this in the [Vendor Portal/CLI]. For information about how to do this with the Vendor API v3, see LINK in the Vendor API v3 documentation"
That said, an alternative might be providing a few key examples of using the API if you all think that would be helpful. I'm mainly just wanting to avoid you all having to update the API docs for the usage endpoints in multiple different locations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fair, I was trying to follow the key examples, I'll try to make a couple examples that are useful and remove the rest.
Signed-off-by: Kyle Squizzato <[email protected]>
paigecalvert
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to go to me! Not sure if @AmberAlston , you wanted to take another look.
Approved on my end
|
It looks good to me as well. Thanks @squizzi |
Story details: https://app.shortcut.com/replicated/story/108273